"""    设置包的导入    """

__all__ = [

    # 用户信息相关

    "login"  # 用户登录

    , "register"  # 用户注册

    , "updateUserInformation"  # 修改用户个人信息

    , "SearchByUsername"  # 查找得到用户信息

    # 病人信息相关

    , "newPatient"  # 新建患者

    , "updatePatientInformation"  # 修改患者信息

    , "SearchPatient"  # 查找患者

    , "getAllPatients"  # 查询所有患者

    , "deletePatient"  #删除患者

    # 配准，求解铰链轴相关

    , "uploadImage"  # 上传stl文件

    , "deleteStlFile" # 删除stl文件

    , "punctuation"  # 上传用户手动标点数据

    , "addAlign"  # 根据两个index获得大致变换矩阵

    , "analyse"  # 调用C++程序进行分析配准

    # 工程文件相关

    , "getProjectFile" # 获取患者工程文件

    , "saveProjectData" # 保存工程文件
]

# 用户信息相关
# login.py
"""
    处理用户登录请求。
    
    :param username: 用户名
    :param password: 密码
    
    :return 
    1. 用户不存在：user not exist
    2. 登录成功：OK
    3. 密码错误：password wrong
"""

# register.py
"""
    处理用户注册请求。

    :param username: 用户名
    :param password: 密码
    :param phone：电话号码
    :param email：电子邮箱
    :param name：姓名
    :param gender：性别
    :param region：所在地区
    :param introduction：自我介绍
    
    :return 
    1. 用户已存在：user exist
    2. 注册成功：OK
"""

# updateUserInformation.py
"""
    处理修改个人信息的请求

    :param username: 用户名
    :param oldPassword: 旧密码
    :param newPassword: 新密码
    :param phone：电话号码
    :param email：电子邮箱
    :param name：姓名
    :param gender：性别
    :param region：所在地区
    :param introduction：自我介绍
    
    :return
    1. 用户不存在：user not exist
    2. 修改密码时原密码错误：password wrong
    3. 修改成功：OK
"""

# 患者信息相关
# newPatient.py
"""
    处理新建患者的请求

    :param name：姓名
    :param gender：性别
    :param age：年龄
    :param time：挂号时间
    :param phone：手机号码
    
    :return
    1. 患者已经存在（根据姓名）：patient exist
    2. 新建成功：OK
"""

# updatePatientInformation.py
"""
    处理修改患者信息的请求
    
    :param patientId：病人id
    :param name：姓名
    :param gender：性别
    :param age：年龄
    :param time：挂号时间
    :param phone：手机号码
    
    :return
    1. 患者不存在："patient not exist"
    2. 修改成功：OK

"""

# SearchPatient.py
"""
    用于查询患者信息
    
    :param name：姓名
    :param phone：手机号码
    
    :return a json string
    {
        "name": patient.name
        , "gender": patient.gender
        , "age": patient.age
        , "time": patient.time
        , "phone": patient.phone
    }
"""

# 配准相关
# uploadImage.py
"""
    用于上传图片（stl文件）
    
    :param patientId：患者id
    :param distance：距离
    :param position：位置（UP, Down）
    :param file：文件
    
    :return "OK"
    
"""

# punctuation.py
"""
    接受标点的数据并保存为txt文件
    
    :param patientId：患者id
    :param points：点的数据
    :param distance：距离
    
    :return "OK"
"""

# analyse.py
"""
    运用之前上传的数据，发起分析请求，得到旋转轴的信息
    
    :param patientId：患者id
    :param distance1：距离1
    :param distance2：距离2
    :return a json string（旋转轴的信息）
    {
        "k1": k1, #
        "b1": b1, #
        "k2": k2, #
        "b2": b2  #
    }
"""
